Repository navigation
README fixes, MIT license GitHub can detect, SECURITY.md - #24
Merged
Merged
Conversation
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
There was a problem hiding this comment.
🟡 Changes recommended
The change removes existing copyright notices without established authorization and includes a README example that accesses a nonexistent second conversion output, causing a panic.
2 open issues
What changed in this PR
This PR updates the Go SDK’s documentation and repository policies without changing SDK code.
Changes:
- Corrects README token usage, result references, streaming arguments, terminology, and links.
- Reformats the MIT license for GitHub detection and updates its copyright notice.
- Adds a security policy describing private vulnerability reporting and supported versions.
| File | Description |
|---|---|
| SECURITY.md | Adds private reporting instructions and security-update policy. |
| README.md | Corrects usage examples, explanatory text, and documentation links. |
| LICENSE.txt | Adopts standard MIT formatting and a ConvertAPI copyright notice. |
Review effort: Balanced
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. No newline at end of file | ||
| MIT License | ||
|
|
||
| Copyright (c) 2012-2026 ConvertAPI |
|
|
||
| // get second file in result | ||
| files, err := res.Files() | ||
| files, err := pdfRes.Files() |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
README bug audit, like the one done for the .NET SDK, plus a license file and a security policy.
os.Getenv("api-token"), an environment variable name that cannot be set in most shells, so the snippets ran with an empty token. They now pass the"api-token"placeholder directly, like the other SDK READMEs, and the full example drops the unusedosimport.res, which was never declared (the result above ispdfRes), andio.Copy(myReader, res)had the writer and reader the wrong way round. NowpdfResandio.Copy(myWriter, pdfRes)./conversionsand/doc/supported-formatsnow point to https://www.convertapi.com/api, and/doc/userand/doc/servers-locationto https://www.convertapi.com/docs/user-information and https://www.convertapi.com/docs/servers-location (where the old URLs redirect).Copyright (c) 2012-2026 ConvertAPI, the same as https://github.com/ConvertAPI/convertapi-library-dotnet/blob/main/LICENSE. The license stays MIT; the old file wrapped the MIT text in extra header lines, so GitHub could not detect it.Checked in
golang:1.25: all fragments compile together (go vet), and the full example converted a DOCX to a 2-page PDF against production.No SDK code changes.
🤖 Generated with Claude Code